home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / editors / blackbrd / bb.doc next >
Text File  |  1988-01-07  |  41KB  |  1,193 lines

  1.                       ██████████
  2.                     ██████████████
  3.                    ███ · ████ · ███
  4.                     ██████████████
  5.                     ██████  ██████
  6.                      ████████████
  7.                        ████████
  8.                       ██││││││██
  9.                        ████████
  10.                    ██▄          ▄██
  11.                     ▀██▄      ▄██▀
  12.                       ▀██▄  ▄██▀
  13.                     ▀████▀
  14.                     ▄████▄
  15.                       ▄██▀  ▀██▄
  16.                     ▄██▀      ▀██▄
  17.                    ██▀          ▀██
  18.  
  19.                     ┌────────────┐
  20.                     │ BLACKBEARD │
  21.                     └────────────┘
  22.  
  23.                 User Supported Software
  24.  
  25.       NOTES:
  26.  
  27.       Version log moved to file BB.LOG (at version 7.33).
  28.  
  29.       BB.DOC is being replaced with an automatic manual generator
  30.       that uses the help file (BB.HLP) along with the key binding
  31.       file (BB.KEY) to produce a manual that is customized with
  32.       your own key mapping. Expect to see this in the next version.
  33.       The help file more correct than BB.DOC.
  34.  
  35.       INTRODUCTION
  36.  
  37.          Blackbeard is a programmer's editor.  It performs the
  38.       editing tasks a programmer needs, in as fast and efficient
  39.       manner as possible.  It works the way you expect it to.  The
  40.       primary use for Blackbeard is for source code editing and it
  41.       does all the things you would expect.  It also has some word
  42.       processing features; these were used to create this
  43.       documentation.
  44.  
  45.       Distribution Registration, and right to copy
  46.  
  47.          Software copyright violation is rampant.  This is why we
  48.       have created Blackbeard.  Because Blackbeard is a superior
  49.       text editor and available for free distribution, there should
  50.       be little need to pirate copyrighted software to obtain
  51.       advanced text editing features.  Please feel free to give
  52.       Blackbeard to your friends.  We are counting on you as a
  53.       participant in the largest distribution network in the nation
  54.       (the owners and users of PCs) to make Blackbeard a popular
  55.       product.  With strong user support, Blackbeard has be
  56.       enhanced with new features and capabilities making it the
  57.       editor of choice.
  58.  
  59.          For twenty (20) dollars you can become a registered owner
  60.       of Blackbeard.  For your $20.00 you will appease your
  61.       conscience about using unregistered software, provide support
  62.       for future enhancements, receive a distinctive Blackbeard
  63.       collectable, a registration sticker, and a copy of the latest
  64.       version of Blackbeard.  The file FORM.TXT can be used as an
  65.       order form.
  66.  
  67.  
  68.                SEND A CHECK MADE OUT TO BLACKBEARD TO:
  69.  
  70.               Blackbeard
  71.               P.O.Box 638
  72.               San Bernardino, California  92402
  73.  
  74.  
  75.                We thank you for your support.
  76.  
  77.       DOCUMENTATION
  78.  
  79.          Blackbeard does not come with a voluminous manual.  The
  80.       design team decided that a good editor should not need a large
  81.       reference manual; most of the documentation is built in.  This
  82.       file explans the features of Blackbeard.
  83.  
  84.  
  85.  
  86.       SETTING UP AND RUNNING BLACKBEARD
  87.  
  88.       Running Blackbeard
  89.  
  90.          To run Blackbeard type:
  91.  
  92.         BB
  93.  
  94.          The screen clears and Blackbeard information appears with a
  95.       request for a filename at the last line of the screen.
  96.       Pressing enter displays a directory of files from which you
  97.       may select a file to edit (see the menus section for how to
  98.       use menus).  See the "Memory Residence" section to install
  99.       Blackbeard as a "pop-up" editor.
  100.  
  101.          You can give Blackbeard a filename upon startup:
  102.  
  103.         BB <filename>
  104.  
  105.          Blackbeard will then display your file.
  106.  
  107.       Status Line
  108.  
  109.          The last line of the screen contains the status
  110.       information.  It looks like:
  111.  
  112.       Line   1  Col    0  <DMIWSTN> Kill     0 Paste     0 C:\filename 846
  113.  
  114.          The status line tells you the line and column you are
  115.       working on.  The letter inside brackets indicate the current
  116.       editing settings.  The possible letters and meanings are
  117.       described in the following chart:
  118.  
  119.       Letter   Meaning
  120.          D     Drawing mode on
  121.          M     Keystroke macro recording on
  122.          I     Insert mode on
  123.          W     Word wrap on
  124.          B     Bullet mode on (and word wrap on)
  125.          S     Case sensitive search on
  126.          T     Auto-tab on
  127.          N     Auto-insert on
  128.  
  129.       Kill followed by the size of the text in the delete buffer.
  130.       Paste followed by the size of text in the paste buffer.  The
  131.       name of the file you are editing followed by its size.
  132.  
  133.       Help and command menus
  134.  
  135.          To access the menus and learn the commands press the
  136.       escape <Esc> key and the menu will pop-up.  You can execute a
  137.       command or select any submenus by positioning the cursor on
  138.       the item (using the keypad keys) and pressing the Enter key
  139.       (<─┘).  To exit a menu without choosing an item press the
  140.       escape key.  The menu action occurs where the cursor was
  141.       before you entered the menu.  With few exceptions the menu
  142.       commands have their direct keyboard counterparts described to
  143.       the right of the English command description.  The direct
  144.       commands use the keyboard letters and the shift () , Alt (α),
  145.       and control (Ctrl) keys.  The following describes how they are
  146.       shown:
  147.  
  148.            ^R - means Ctrl-R
  149.            R - means Shift-R
  150.            αR - means Alt-R
  151.  
  152.          The function keys are designated as F1 - F10.
  153.  
  154.       Prompt Line
  155.  
  156.          Blackbeard will prompt you for various editing strings on
  157.       the status line.  This includes search/replace string and new
  158.       filename.  Blackbeard has a built in prompt line editor.
  159.       Prompt line editing uses arrows, backspace, Home, End Up
  160.       arrow (to retrieve previous data), Ins and Del.  The Esc key
  161.       aborts the prompt and enter to complete the prompt.
  162.  
  163.       CONFIGURATION
  164.  
  165.          When Blackbeard starts up it looks for five files: the
  166.       configuration file (BB.CFG), the key binding file (BB.KEY),
  167.       the macro file (BB.MAC), the paste buffer (BB.PST), and the
  168.       language file (BB.LNG).
  169.          With the exception of the Paste file, Blackbeard looks in
  170.       the current subdirectory for these files.  If there is not a
  171.       file in the current subdirectory, Blackbeard will look at the
  172.       file defined in the DOS environment by the appropriate
  173.       symbol.  This allows you to keep one configuration file and
  174.       use Blackbeard from any disk or directory.  To set the default
  175.       Blackbeard file use the following command:
  176.  
  177.          SET BBCFG=<filename>
  178.  
  179.          for example:  SET BBCFG=C:\BB\BB.CFG
  180.  
  181.          The appropriate symbols are:
  182.  
  183.          BBDIR - default directory for most of the following
  184.          BBCFG - Configuration file.
  185.          BBKEY - Key binding file.
  186.          BBMAC - Macro file.
  187.          BBPST - Paste file.
  188.          BBLNG - Language file.
  189.  
  190.          For the paste buffer, Blackbeard looks first for the symbol
  191.          BBPST.  If found, the paste filename defined by the set
  192.          statement is used.  If not the paste file, a message is
  193.          issued and the paste buffer is limited in size and not
  194.          paged out to a file.
  195.  
  196.       Configuration File
  197.  
  198.          Blackbeard keeps a configuration file that allows you to
  199.       customize the following areas:
  200.  
  201.         -  all items from the OPTIONS MENU
  202.         -  all items from the SETTINGS MENU
  203.         -  Window colors
  204.         -  WIndow sizes
  205.         -  the status line settings
  206.  
  207.          Blackbeard looks in the current subdirectory for a file
  208.       named BB.CFG.  This file sets the configuration setttings.  If
  209.       there is not a file named BB.CFG in the current subdirectory,
  210.       Blackbeard will look in the BB DOS environment subdirectory
  211.       for this file, if it is found it will use the filename
  212.       supplied with the symbol.  This will let you keep one
  213.       configuration file and use Blackbeard from any disk or
  214.       directory.
  215.  
  216.          See the OPTIONS/SETTINGS menu for the read and save
  217.       configuration commands.  These commands will request a
  218.       filename and default to the current path and BB.CFG filename
  219.       if none is given.
  220.  
  221.       Macro file
  222.  
  223.          Blackbeard allows you to define and save keyboard macros.
  224.       Blackbeard looks in the current subdirectory for a file named
  225.       BB.MAC.  This file contains your macros.  If there is not a
  226.       file named BB.MAC in the current subdirectory, Blackbeard will
  227.       look in the BB DOS environment subdirectory for this file, if
  228.       it is found it will use the filename supplied with the symbol.
  229.  
  230.          See the macros menu for the read and save macro commands.
  231.       To read in macro files with different filenames simply enter
  232.       the desired file name to the read file prompt.  These commands
  233.       will request a filename and default to the current path and
  234.       BB.CFG filename if none is given.
  235.  
  236.       Key binding File
  237.  
  238.          Blackbeard keeps a key binding file that will allow you to
  239.       redefine the keystrokes: Blackbeard looks in the current
  240.       subdirectory for a file named BB.KEY.  This file defines the
  241.       keyboard binding.  If there is not a file named BB.KEY in the
  242.       current subdirectory, Blackbeard will look in the BB DOS
  243.       environment subdirectory for this file, if it is found it will
  244.       use the filename supplied with the symbol.  This will let you
  245.       keep one keyboard file and use Blackbeard from any disk or
  246.       directory.
  247.  
  248.          See the OPTIONS/SETTINGS/KEYS menu for the read and save
  249.       key bindings commands.  These commands will request a filename
  250.       and default to the current path and BB.KEY filename if none is
  251.       given.
  252.  
  253.       Other configuration
  254.  
  255.          If you are using the IBM monochrome adapter or a
  256.       color/graphics adapter with a color monitor, you will not have
  257.       to configure Blackbeard for your system.  If you are using
  258.       Blackbeard with a color/graphics adapter and a monochrome
  259.       monitor, you will have to configure Blackbeard so that it does
  260.       not use color.  To do this run Blackbeard, press αF9 (to turn
  261.       off color) and save your configuration using the configuration
  262.       menu.
  263.  
  264.       HOW BLACKBEARD HANDLES FILES
  265.  
  266.       Virtually virtual memory
  267.  
  268.          Blackbeard uses a virtually virtual memory method to handle
  269.       large files.  This means it pages the file in and out of
  270.       memory.  The messages Reading file and Writing file appear on
  271.       the status line to indicate when Blackbeard is paging the
  272.       file.  Blackbeard uses to two buffers to keep track of your
  273.       file.  One that keeps track of every line in the file and one
  274.       that pages your file in and out.  Blackbeard's file size is
  275.       limited by the number of lines.  The default is about 8000
  276.       lines (this is large enough for almost all text files).
  277.       However, you can tell Blackbeard how to distribute its vitrual
  278.       memory buffers.  The line buffer's size ranges from 4000 to
  279.       about 24000.  The default is 8000.  It should be set to the
  280.       maximum expected file size (in terms of lines) you will edit.
  281.       To set the line limit run Blackbeard with either of the
  282.       following commands:
  283.  
  284.          BB =# of lines or
  285.          BB <filename> =# of lines
  286.  
  287.          Example:
  288.  
  289.          BB read.me =20000
  290.  
  291.          will run Blackbeard such that it can accept files that have
  292.       up to 20000 lines.
  293.  
  294.       Backup
  295.  
  296.          Blackbeard can create a backup file, at startup.
  297.       Blackbeard will copy the original file to a .BAK file.  While
  298.       editing, Blackbeard will page your file in and out of memory.
  299.       If the computer should crash while editing; the edited file
  300.       may be unusable.  The default is not to provide a backup file.
  301.  
  302.       File saving
  303.  
  304.          Blackbeard always works on the current file.  When you
  305.       change to a window that contains a different file, the file in
  306.       the previous window is saved and the new file is read in and
  307.       you are positioned where you left off.  Every time you change
  308.       to a window with a different file (or one of the three special
  309.       purpose windows), Blackbeard saves the file.  This means you
  310.       cannot go back to your original text.  (If automatic backup is
  311.       on, a backup is made when you enter a new file with the new
  312.       file command).
  313.  
  314.       Memory Residence
  315.       /* THIS FEATURE HAS BEEN REMOVED WITH VERSION 7.+ */
  316.  
  317.          Blackbeard can be loaded in the background and popped up
  318.       (like Borland's Sidekick).  It uses up about 150k bytes of
  319.       memory.  To load Blackbeard in the background execute
  320.       Blackbeard with the following command:
  321.  
  322.       BB =r
  323.  
  324.          You can specify a number of lines with BB =r#####
  325.  
  326.          Once Blackbeard is loaded in the background it is popped up
  327.       with the file you were last editing with the ALT = (α=) key.
  328.       It will resume editing where you last left off.  Popping
  329.       Blackbeard up with ALT - (α-) pops up Blackbeard and you are
  330.       queried for a new filename.
  331.  
  332.          Notes about operating Blackbeard in the background:
  333.  
  334.          o  When popped up from the command prompt, the DOS window
  335.         and DOS exit commands do not work.  They work fine when
  336.         popped up behind another program.
  337.  
  338.          o  Beware of popping Blackbeard up behind a graphics
  339.         program.
  340.  
  341.  
  342.       COMMANDS
  343.  
  344.          The remainder of this document describes all the Blackbeard
  345.       commands and their original key binding by categories.
  346.  
  347.       CURSOR MOVEMENT
  348.  
  349.          This section defines the commands to move the cursor and
  350.       window about.
  351.  
  352.          COL LEFT  (->)
  353.         Moves the cursor left one column.  When the cursor
  354.         reaches the window edge, the window is scrolled.
  355.  
  356.          COL RIGHT  (<-)
  357.         Moves the cursor right one column.  When the cursor
  358.         reaches the window edge, the window is scrolled.
  359.  
  360.          ROW UP ()
  361.         Moves the cursor up one line.  If the cursor is at the
  362.         top of the window, then the window moves up a line.
  363.  
  364.          ROW DOWN  ()
  365.         Moves the cursor down one line.  If the cursor is at the
  366.         bottom of the window, then the window moves down a line.
  367.  
  368.          HOME  (Home)
  369.         Moves the cursor to the upper left corner of the window.
  370.  
  371.          END OF SCREEN  (End)
  372.         Moves the cursor to the lower left corner of the window.
  373.  
  374.          PAGE UP  (PgUp)
  375.         Moves the window up the length of the window.
  376.  
  377.          PAGE DOWN  (PgDn)
  378.         Moves the window down the length of the window.
  379.  
  380.          START OF FILE  (^PgUp)
  381.         Moves to the start of the file.
  382.  
  383.          END OF FILE  (^PgDn)
  384.         Moves to the end of the file.
  385.  
  386.          WORD RIGHT  (^->)
  387.         Moves the cursor a word to the right.  If the next word
  388.         is not in the window, then the window is repositioned
  389.         with the word centered in the window.
  390.  
  391.          WORD LEFT  (^<-)
  392.         Moves the cursor a word to the left.  If the next word
  393.         is not in the window, then the window is repositioned
  394.         with the word centered in the window.
  395.  
  396.          LEFT OF SCREEN  (^Home)
  397.         Puts the cursor at the left edge of the window.
  398.  
  399.          RIGHT OF SCREEN  (^End)
  400.         Puts the cursor at the right edge of the window.
  401.  
  402.          END OF LINE  (^E)
  403.         Places the cursor at the end of the line.  This may
  404.         involve shifting the window to the right.
  405.  
  406.          GOTO  (^G)
  407.         Goto a specified line of the file.  If the line is
  408.         greater than the number of lines in the file, END OF
  409.         FILE is performed.
  410.  
  411.          TAB  (->| or ^I)
  412.         If fixed tabs are on, the cursor moves right to the next
  413.         tab.  If fixed tabs are off, the cursor moves to the
  414.         right by the tab size columns. If tab insert is on
  415.         then tab size spaces are inserted.
  416.  
  417.          TAB LEFT  (|<- or ^O)
  418.         If fixed tabs are on, the cursor moves left to the next
  419.         tab.  If fixed tabs are off, the cursor moves to the
  420.         left by the tab size columns.
  421.  
  422.          RETURN  (^Enter or ^J)
  423.         Shifts the window to the left edge and place the cursor
  424.         in the first column and down a line.
  425.  
  426.       EDIT
  427.  
  428.          Standard editing operations are available.  The kill buffer
  429.       contains about the last 25 deleted lines.
  430.  
  431.          INSERT/OVERSTRIKE  (Ins)
  432.         Toggles insert and overstrike character mode.
  433.  
  434.          DELETE CHAR  (Del)
  435.         Deletes the current character.
  436.  
  437.          DELETE LINE  (^D)
  438.         Deletes the current line to the Kill buffer.
  439.  
  440.          BACKSPACE  (Backspace or ^H)
  441.         Deletes the previous character.  If the cursor is at
  442.         column one, nothing happens.
  443.  
  444.          BREAK LINE  (^K - mnemonic is krack)
  445.         Breaks the line at the current cursor position.
  446.  
  447.          INSERT LINE  (^I)
  448.         Inserts a line at the current cursor positon.
  449.  
  450.          RETURN & INSERT LINE  (Enter or ^M)
  451.         Performs RETURN and INSERT LINE.
  452.  
  453.          UNDELETE LINE  (^U)
  454.         Inserts a line from the Kill buffer at the current
  455.         line.  That line is deleted from the Kill buffer.
  456.  
  457.          DELETE TO EOL  (^W - mnemonic is waste)
  458.         Deletes the rest of the line.  Undo will undo this
  459.         function.
  460.  
  461.          YANK LINE  (^Y)
  462.         Inserts a line from the Kill buffer at the current
  463.         line.  This allows multiple insertion of the same
  464.         deleted line.  It works as a quick cut and paste.
  465.  
  466.          DELETE BLOCK  (αD)
  467.         Deletes a marked block.
  468.  
  469.          JOIN LINE  (αK)
  470.         Joins the next line to the current line.  A space
  471.         separates the lines.
  472.  
  473.          UNDO  (αU)
  474.         Restores the line to the last edited state.
  475.  
  476.          BREAK & NEXT LINE (αJ)
  477.         Breaks the current line and set cursor to next line
  478.  
  479.          SELF INSERT
  480.         Inserts the character.
  481.  
  482.          DELETE WORD  (^Backspace)
  483.         Deletes the next word.
  484.  
  485.       FILE
  486.  
  487.          BACKUP FILE  (α1)
  488.         Copies the current file to a file with the same name but
  489.         with a .BAK extension.
  490.  
  491.          NEW FILE  (^N)
  492.         Opens a new file to edit in the current window.  If no
  493.         filename is given, a pop-up menu displays a directory.
  494.         Wildcards in the filename can constrain the directory.
  495.         Select the file to edit using the standard menu keys.
  496.         Esc if you do not want to select a file.
  497.  
  498.          WRITE FILE  (αW)
  499.         Write out the file
  500.  
  501.          REREAD FILE  (αN)
  502.         Rereads the file.
  503.  
  504.          SWITCH TO FILE  (αG)
  505.         Switchs to the file under the cursor.  The filename is
  506.         delimited by a non-file character.
  507.  
  508.          INSERT FILE
  509.         Will insert the specified file before the current line.
  510.  
  511.       WINDOWS
  512.  
  513.          Blackbeard is a windowed editor with 13 windows; 10 for
  514.       normal editing, and three for special purposes.  You can edit
  515.       one or more files in the general editing windows.  To edit a
  516.       different file in a window just bring up the window using Ctrl
  517.       and one of the function (F1-F10) keys and press ^N to edit a
  518.       different file.  Note that this does not affect any other
  519.       windows; only the current window you are in.  The current file
  520.       will "follow you around" to the un-initialized windows that
  521.       you move to.  You can select, re-size, and color windows from
  522.       the window sub menu.
  523.  
  524.       ┌─────────────────────────────────────────────────────────────────┐
  525.       │                  Windows and their default sizes                │
  526.       ├──────────────────────────────────────┬──────────────────────────┤
  527.       │  ^F1 - Main window; full screen      │    αF1 - DOS window      │
  528.       │  ^F2 - full screen                   │    αF3 - Paste window    │
  529.       │  ^F3 - left half of screen           │    αF4 - Kill window     │
  530.       │  ^F4 - right half of screen          │                          │
  531.       │  ^F5 - top half of screen            │                          │
  532.       │  ^F6 - bottom half of screen         │                          │
  533.       │  ^F7 - left half of screen           │                          │
  534.       │  ^F8 - right half of screen          │                          │
  535.       │  ^F9 - full screen                   │                          │
  536.       │  ^F10 - full screen                  │                          │
  537.       └──────────────────────────────────────┴──────────────────────────┘
  538.  
  539.  
  540.          WINDOW 1 (^F1)
  541.         Selects window 1.
  542.  
  543.          WINDOW 2 (^F2)
  544.         Selects window 2.
  545.  
  546.          WINDOW 3 (^F3)
  547.         Selects window 3.
  548.  
  549.          WINDOW 4 (^F4)
  550.         Selects window 4.
  551.  
  552.          WINDOW 5 (^F5)
  553.         Selects window 5.
  554.  
  555.          WINDOW 6 (^F6)
  556.         Selects window 6.
  557.  
  558.          WINDOW 7 (^F7)
  559.         Selects window 7.
  560.  
  561.          WINDOW 8 (^F8)
  562.         Selects window 8.
  563.  
  564.          WINDOW 9 (^F9)
  565.         Selects window 9.
  566.  
  567.          WINDOW 10 (^F10)
  568.         Selects window 10.
  569.  
  570.          EXPAND  (αF5)
  571.         Expands the current window to a full screen.
  572.  
  573.          SELECT  (αF6)
  574.         Displays a pop-up menu of windows and their files.
  575.         Select the window desired.  Esc to stay in the current
  576.         window.
  577.  
  578.          MOVE/FRAME  (αF7)
  579.         Moves the current window.  Frame changes the size of the
  580.         window by moving the lower right corner of the window.
  581.         Enter switches modes.  Esc completes moving/framing.
  582.  
  583.          COLOR/B&W  (αF9)
  584.         Turns color on and off.
  585.  
  586.          SELECT COLOR  (αF10)
  587.         Selects the foreground and background color of the
  588.         current window.
  589.  
  590.          KILL WINDOW  (αF4)
  591.         The kill window contains deleted text, which is edited
  592.         like any other window.
  593.  
  594.          PASTE WINDOW  (αF3 or F10)
  595.         The paste window contains the paste buffer which has the
  596.         text you have cut out.  It may be edited like any other
  597.         window.
  598.  
  599.          DOS WINDOW  (αF1)
  600.         The DOS window allows you to interact with DOS in a
  601.         windowed environment.
  602.  
  603.            ┌───────────────────────────────────────────────────────┐
  604.            │ Use caution when in the "DOS window" (αF1). All line  │
  605.            │ oriented commands such as compilers and linkers will  │
  606.            │ work OK. Some programs will trash you royal, use      │
  607.            │ the "exit to DOS" function αF2 for these.             │
  608.            └───────────────────────────────────────────────────────┘
  609.  
  610.  
  611.       FIND & REPLACE
  612.          This section explains how to find strings and replace them
  613.          with other strings.
  614.  
  615.          FIND  (^F)
  616.         Searches the file for a string.  It searchs forward from
  617.         the current position to the end of the file.  You can
  618.         enter special characters into a search string by
  619.         pressing the control key or using the Alt key and the
  620.         numeric keypad.  Esc and Enter abort searching.  To
  621.         enter the character code for Escape use the Alt key pad
  622.         (in num lock mode) and enter 27 (the code for escape).
  623.  
  624.          FIND & REPLACE  (^R)
  625.         Find a string and replaces one string with another.  The
  626.         replacements can be conditional, meaning Blackbeard will
  627.         ask you whether you actually want to replace the string
  628.         before it replaces it.  Replacements can be global,
  629.         meaning replace every occurrence of the string from the
  630.         current cursor position to the end of the file.
  631.  
  632.          REPEAT FIND  (αF)
  633.         Repeats the last search.
  634.  
  635.          REPEAT REPLACE  (αR)
  636.         Repeats the last replace.
  637.  
  638.          SEARCH REVERSE (^S)
  639.         Searchs the file for the requested string from the
  640.         current cursor position backward to the start of the
  641.         file.
  642.  
  643.          REPEAT SEARCH REVERSE (αS)
  644.         Repeats the last search reverse
  645.  
  646.       Regular Expression Search
  647.          The following characters are used to perform reqular
  648.       expression searching.  This set matches the grep utility very
  649.       closely.  We will be integrating a help facility in to the
  650.       search function very soon now.  For now this is what you get.
  651.       This search information is also contained on the distribution
  652.       diskette in the file re.hlp.
  653.  
  654.          x     An ordinary character (not mentioned below) matches
  655.            that character.
  656.  
  657.          \     The backslash quotes any character.  \"\\$\" matches
  658.            a dollar-sign.
  659.  
  660.          ^     A circumflex at the beginning of an expression
  661.            matches the beginning of a line.
  662.  
  663.          $     A dollar-sign at the end of an expression matches the
  664.            end of a line.
  665.  
  666.          .     A period matches any character except \"new-line\".
  667.  
  668.          :a    A colon matches a class of characters described by
  669.            the following
  670.  
  671.          :d    character.  \":a\" matches any alphabetic, \":d\"
  672.            matches digits,
  673.  
  674.          :n    \":n\" matches alphanumerics, \": \" matches spaces,
  675.            tabs, and
  676.  
  677.          :    other control characters, such as new-line.
  678.  
  679.          *    An expression followed by an asterisk matches zero or
  680.           more occurrances of that expression: \"fo*\" matches
  681.           \"f\", \"fo\" \"foo\", etc.
  682.  
  683.          +    An expression followed by a plus sign matches one or
  684.           more occurrances of that expression: \"fo+\" matches
  685.           \"fo\", etc.
  686.  
  687.          -    An expression followed by a minus sign optionally
  688.           matches the expression.
  689.  
  690.          []   A string enclosed in square brackets matches any
  691.           character in that string, but no others.  If the first
  692.           character in the string is a circumflex, the
  693.           expression matches any character except \"new-line\"
  694.           and the characters in the string.  For example,
  695.           \"[xyz]\" matches \"xx\" and \"zyx\", while \"[^xyz]\"
  696.           matches \"abc\" but not \"axb\".  A range of
  697.           characters may be specified by two characters
  698.           separated by \"-\".  Note that, [a-z] matches
  699.           alphabetics, while [z-a] never matches.
  700.  
  701.       The concatenation of regular expressions is a regular
  702.       expression.
  703.  
  704.       CUT & PASTE
  705.  
  706.          There are two types of regions: columns and ragged text.
  707.       For columns, "mark start" marks the upper left corner and
  708.       "mark end" marks the lower right corner of the block.  For
  709.       ragged text, "mark start" marks the start of a region, and
  710.       "mark end" marks the end of a region.  If "mark start" is
  711.       pressed with the cursor position after the marked region it
  712.       extends the region; the converse is true with respect to "mark
  713.       end." Try it and you will get used to how it works; it works
  714.       like you would expect it to.
  715.  
  716.          MARK START  (F1)
  717.         Marks the start of a region.
  718.  
  719.          MARK END  (F2)
  720.         Marks the end of a region.
  721.  
  722.          GRAB  (F3)
  723.         Copies the region to the paste buffer.
  724.  
  725.          CUT  (F4)
  726.         Cuts out the region to the paste buffer.
  727.  
  728.          SHIFT LEFT  (F5)
  729.         Shifts the selected lines left by tab size characters.
  730.  
  731.          SHIFT RIGHT  (F6)
  732.         Shifts the selected lines right by tab size characters.
  733.  
  734.          COPY  (F7)
  735.         Copys contents of paste buffer into the current file.
  736.  
  737.          PASTE  (F8)
  738.         Cuts the contents of the paste buffer into the current
  739.         file.
  740.  
  741.          UNMARK  (F9)
  742.         Resets the markers.
  743.  
  744.          PASTE WINDOW  (F10)
  745.         Selects the paste window for editing.
  746.  
  747.          CLEAR PASTE  (F9)
  748.         Empties the paste buffer.
  749.  
  750.       COLUMNS
  751.  
  752.          There are two types of regions: columns and ragged text.
  753.       For columns, "mark start" marks the upper left corner and
  754.       "mark end" marks the lower right corner of the block.  For
  755.       ragged text, "mark start" marks the start of a region, and
  756.       "mark end" marks the end of a region.  If "mark start" is
  757.       pressed with the cursor position after the marked region it
  758.       extends the region; the converse is true with respect to "mark
  759.       end." Try it and you will get used to how it works; it works
  760.       like you would expect it to.
  761.  
  762.          MARK COL START  (F1)
  763.         Marks the upper left corner of the column.
  764.  
  765.          MARK COL END  (F2)
  766.         Marks the lower right corner of the column.
  767.  
  768.          GRAB COL  (F3)
  769.         Copies the column to the paste buffer.
  770.  
  771.          CUT COL  (F4)
  772.         Cuts the column into the paste buffer.
  773.  
  774.          REMOVE COL  (F5)
  775.         Copies the column to the paste buffer and clears the
  776.         column in the current file.
  777.  
  778.          REPLACE COL  (F6)
  779.         Overlays the paste buffer column-wise at the current
  780.         cursor position.
  781.  
  782.          COPY COL  (F7)
  783.         Inserts the paste buffer column-wise at the current
  784.         cursor positon.
  785.  
  786.          PASTE COL  (F8)
  787.         Inserts the paste buffer column-wise at the current
  788.         cursor positon and deletes it from the paste buffer
  789.  
  790.          CLEAR PASTE  (F9)
  791.         Empties the paste buffer.
  792.  
  793.          SHIFT LEFT  (F5)
  794.         Shifts the selected lines at the current column to the
  795.         left tab size columns.
  796.  
  797.          SHIFT RIGHT  (F6)
  798.         Shifts the selected lines at the current column to the
  799.         right tab size columns.
  800.  
  801.          UNMARK  (F9)
  802.         Clears the markers.
  803.  
  804.          PASTE WINDOW  (F10)
  805.         Selects the paste window for editing.
  806.  
  807.       MACROS
  808.  
  809.          One of the most powerful Blackbeard features is the
  810.       keystroke macro capability invoked by pressing ^V.  When ^V is
  811.       pressed Blackbeard starts remembering keystrokes that you
  812.       press until ^V is pressed again (the number of keystrokes
  813.       remembered is about 500).  To reexecute this remembered
  814.       sequence of keystrokes press ^X.  Blackbeard allows you to
  815.       name your macros; delete macros you have named; execute named
  816.       macros; save the macros to a file and read them back in.
  817.  
  818.          DEFINE MACRO  (^V)
  819.         Starts and stops keystroke remembering
  820.  
  821.          EXECUTE MACRO  (^X)
  822.         Executes the current keystroke macro
  823.  
  824.          NAME MACRO  (αV)
  825.         Assigns a name to the current keystroke macro.
  826.  
  827.          WRITE MACROS
  828.         Writes the named macros to a file.  If no filename is
  829.         given BB.MAC is assumed.
  830.  
  831.          READ MACROS
  832.         Reads in a macro file.  If no filename is given BB.MAC
  833.         is assumed.
  834.  
  835.          EXECUTE NAMED MACRO  (αX)
  836.         A menu of named macros appears.  Select the desired
  837.         macro to execute.  This macro now becomes the current
  838.         macro.
  839.  
  840.          DELETE MACRO  (αM)
  841.         A menu of named macros appears.  Select the macro you
  842.         want to delete.
  843.  
  844.       WORD PROCESSING
  845.  
  846.          This section describes the word processing functions.
  847.  
  848.          ADJUST PARAGRAPH  (^P)
  849.         Reformats from the beginning of the current line to the
  850.         next empty line or the end of the file using the current
  851.         right margin and the indention level of the following
  852.         line.  This allows the first line to be a different
  853.         format than the rest of the paragraph.
  854.  
  855.          ADJUST SPECIAL  (αP)
  856.         Reformats the same as ADJUST PARAGRAPH, except when
  857.         justifying no spaces are inserted between the first and
  858.         second word.  This is very useful for bulletted
  859.         paragraphs.
  860.  
  861.          ADJUST BLOCK
  862.         Reformats from the beginning of the current line to the
  863.         next empty line or the end of the file using the current
  864.         right margin and the indention level of the current
  865.         line.
  866.  
  867.          CENTER LINE  (αC)
  868.         Centers the line.
  869.  
  870.          TRANSPOSE  (^T)
  871.         Swaps the current character with the next character.
  872.  
  873.          CHANGE CASE  (αT)
  874.         Changes the current chararter's case according to the
  875.         change case mode.
  876.  
  877.          CHANGE CASE REGION  (F10)
  878.         Changes a select region of text to the change case mode.
  879.  
  880.          BULLET  (^B)
  881.         Set an indent column for word wrap.  Wrapped wors are be
  882.         indented to this column rather than the first column or
  883.         current line's start column.
  884.  
  885.          BULLET OFF  (αB)
  886.         Turns bullet mode off.
  887.  
  888.  
  889.       OPTIONS/SETTINGS/KEYS/STATUS LINE
  890.  
  891.          The options and status line menus work different from the
  892.       command menu.  The are toggle menus with ON shown as high
  893.       intensity and OFF as normal intensity.  To toggle an item use
  894.       the enter key.  Exit with escape.
  895.  
  896.          OPTIONS  (^A)
  897.         Brings up the options menu.  It contains the following
  898.         information.
  899.  
  900.            Insert characters - select insert or overstrike
  901.                        character insertion
  902.  
  903.            Word wrap - words typed past the right margin (see
  904.                    SETTINGS menu) are wrapped to the next
  905.                    line.
  906.  
  907.            Case sensitive search - Consider (ON) or ignore (OFF)
  908.                        case when searching for a
  909.                        string.
  910.  
  911.            Auto-tab - Align the cursor to the column of the
  912.                   current line when inserting lines,
  913.                   deleting line, and word wrapping.  Return
  914.                   when in auto-insert and auto-tab uses the
  915.                   column of the previous line unless the
  916.                   line is blank where it uses the last
  917.                   indent value.
  918.  
  919.            Auto-insert - Return inserts a line (ON) or simply
  920.                  goes to the next line (OFF)
  921.  
  922.            Fixed-tab - Interpret the tab key as increasing the
  923.                    indent level (OFF) or as jumping to fixed
  924.                    tab locations (ON) (tabs are toggled on
  925.                    and off with αI).
  926.  
  927.            Justify - Perform justification (by inserting extra
  928.                  spaces) when word wrapping and adjusting
  929.                  paragraphs.
  930.  
  931.            Display tabs - Indicates whether to perform a
  932.                   tab-to-space translation when
  933.                   displaying the file.  ON means tabs
  934.                   are not translated, but displayed as
  935.                   the tab character.  OFF means tabs are
  936.                   translated to the appropriate white
  937.                   space
  938.  
  939.            Auto backup - ON indicates that a backup of you file
  940.                  is written to the same filename with a
  941.                  .BAK extension when you edit the file.
  942.                  OFF means no backup is made.
  943.  
  944.            Regular Expression Search - ON indicates regular
  945.                            expression searching is
  946.                            performed.  Off indicates
  947.                            normal search
  948.  
  949.            Insert tabs - On means when the tab function is
  950.                  executed a tab is inserted.  Off means
  951.                  the tab only moves the cursor to the
  952.                  next tab position.
  953.  
  954.         WRITE CONFIG
  955.            Writes the configuration to the filename specified.
  956.            If none is given BB.CFG is assumed.
  957.  
  958.         READ CONFIG
  959.            Writes the configuration to the filename specified.
  960.            If none is given BB.CFG is assumed.
  961.  
  962.         SETTINGS  (αA)
  963.            Brings up the settings menu.  It contains the
  964.            following information.
  965.  
  966.            Right margin - Sets the right margin used for word
  967.                   wrap and paragraph reformatting.
  968.  
  969.            Tab size - Sets the tab size used for shifting text
  970.                   left or right and also used to move the
  971.                   cursor when the tab function is executed
  972.                   in non-fixed mode.
  973.  
  974.            Line size - Sets the size of the line for line
  975.                    drawing mode.  0 = dashed line; 1 =
  976.                    single width; 2 = double width.
  977.  
  978.            Case mode - Set the change case mode used with change
  979.                    case and change case region.  0 = Flip
  980.                    case; 1 = Upper case; 2 = Lower case
  981.  
  982.            Insert number - Sets the number to insert with the
  983.                    insert number function.
  984.  
  985.         STATUS
  986.            Brings up the status line menu.
  987.  
  988.         STATUS COLOR
  989.            Selects the foreground and background color of the
  990.            status line.
  991.  
  992.         SET DELIMETERS
  993.            Sets the characters that define what are to be
  994.            delimeters between words.  Works with right_word,
  995.            left_word and delete_word and another delimeted type
  996.            of command.
  997.  
  998.        KEY BINDING
  999.  
  1000.          Information about binding the keys is contained in the file
  1001.       BBC.DOC.
  1002.  
  1003.       Commands
  1004.  
  1005.         SHOW BINDINGS  (α2)
  1006.            Displays the current key to function bindings.
  1007.  
  1008.         WRITE BINDINGS
  1009.            Writes the key bindings to the specified file.  If no
  1010.            filename is given BB.KEY is used.
  1011.  
  1012.         READ BINDINGS
  1013.            Read the key bindings from the specified file.  If no
  1014.            filename is given BB.KEY is used.
  1015.  
  1016.       MISCELLANEOUS
  1017.          There are many miscellaneous functions to satisfy
  1018.       specialized needs.  This section describes these functions.
  1019.  
  1020.         NULL
  1021.            This function does nothing.
  1022.  
  1023.         MENUS  (Esc)
  1024.            Calls up the command menus.
  1025.  
  1026.         REPEAT MENU COMMAND  (αE)
  1027.            Repeats the last menu command.  This key is bound to
  1028.            one of the mouse buttons.
  1029.  
  1030.         EXIT  (^Z)
  1031.            Saves the file and exits Blackbeard
  1032.  
  1033.         ABORT  (αZ)
  1034.            Exits Blackbeard without saving the current file.
  1035.            Useful if you selected a strange file to edit or want
  1036.            to start over.
  1037.  
  1038.         EXIT TO DOS  (αF2)
  1039.            Saves the file; keeps Blackbeard memory resident and
  1040.            returns to DOS.  To return to Blackbeard type EXIT at
  1041.            the DOS prompt.
  1042.  
  1043.         REPEAT KEY (α4)
  1044.            Repeats a key a selected number of times.  You are
  1045.            prompted for the repeat count and then the key to
  1046.            repeat.  To interrupt repeat hit any key.
  1047.  
  1048.         TAB TOGGLE  (αI)
  1049.            Sets and resets a tab stop in fixed tab mode.
  1050.  
  1051.         ASCII CHART  (^C)
  1052.            Displays an ascii chart with DECIMAL, HEX and
  1053.            Character.  Scroll the chart with the left, right, up
  1054.            and down arrows.  Esc to exit.
  1055.  
  1056.         INSERT SPECIAL CHAR  (^Q)
  1057.            Inserts any ascii character specified by number.  If
  1058.            no value is input the character 0 or NUL is
  1059.            inserted.  This is very useful for putting in special
  1060.            printer escape sequences.  The ALT key and the
  1061.            numeric keypad can also perform this function for
  1062.            certain characters, but not the Ctrl keys.
  1063.  
  1064.         LAST DOS COMMAND  (αL)
  1065.            Displays the last DOS command executed in the DOS
  1066.            window.
  1067.  
  1068.         LINE DRAWING  (αQ)
  1069.            BLACKBEARD has a line drawing capability which can be
  1070.            used to make boxes, organization charts, and other
  1071.            line oriented pictures.  It is not a true graphics
  1072.            feature, but instead uses the IBM PC line
  1073.            characters.  You can think of the line drawing as a
  1074.            crude pen plotter.  Press αQ to drop the pen (the αQ
  1075.            is really a toggle, which raises or loweres the
  1076.            pen).  At this point, any cursor movements using the
  1077.            cursor keys will cause a line to be drawn.  You can
  1078.            use the four arrow keys to move left, right, up, and
  1079.            down.  In addition, you can use the four corner keys
  1080.            (1,3,7,9) to move along a diagonal, but the diagonal
  1081.            lines are not as well formed as the horizontal and
  1082.            vertical line.  Here is a sample picture :
  1083.  
  1084.                   ┌───────────┐        ┌─────────────┐
  1085.                   │ Box 1     ├────────┤  Box 2      │
  1086.                   │           │        │             │
  1087.                   └───────────┘        └─────────────┘
  1088.  
  1089.               The boxes are formed by dropping the pen (αQ),
  1090.            moving the cursor, and then lifting the pen (αQ
  1091.            again).
  1092.  
  1093.               The line drawing characters will only print on
  1094.            printers which support the IBM PC character set (such
  1095.            as the IBM Graphics printer, the STAR SG-10, and some
  1096.            EPSONS).  If you do not have one of the correct
  1097.            printers, you can still do some line drawing using a
  1098.            different line width.  BLACKBEARD supports three line
  1099.            widths: 0, 1, and 2.  The picture above is using line
  1100.            width 1, while this (═══════) is line width 2.  Most
  1101.            printers actually print the line width 2 as line
  1102.            width 1.  If this is true of your printer, then line
  1103.            width 2 is useful mainly for on screen text.  Line
  1104.            width 0 draws lines using the standard ASCII
  1105.            characters.  The characters are hyphens (---) for
  1106.            horizontal lines, bars (|) for vertical lines, and
  1107.            plus (+) for corner connectors.  Here is a line width
  1108.            0 box :
  1109.  
  1110.                  +-----------+     +-----------+
  1111.                  |           |     |           |
  1112.                  | Line 0    +-----+  Boxes    |
  1113.                  |           |     |           |
  1114.                  +-----------+     +-----------+
  1115.  
  1116.               These will print on nearly any printer.
  1117.  
  1118.            A few tips for using boxes.  A good way is to build
  1119.            your boxes, and then fill them with text with insert
  1120.            mode off.  The INS key toggle insert mode.  The flags
  1121.            on the bottom status line show an I for insert mode.
  1122.            Insert mode is turned off when the I is not visible.
  1123.  
  1124.       String Replacement/Language Sensitive Editing
  1125.  
  1126.          Blackbead reads in the file BB.LNG (or the file associated
  1127.       with the symbol BBLNG) if present into a "language" window.
  1128.       When the expand language function is executed the symbol at
  1129.       the current cursor position is looked up in this window.  A
  1130.       symbol is designated with either a > or < sign.  If the symbol
  1131.       is designated with a < then the symbol is replaced by the set
  1132.       of lines that follow the symbol upto the next > or < sign or
  1133.       end of file.  If the symbol is designated with a >, then you
  1134.       are prompted for which replacement you want to make from the
  1135.       lines that follow the symbol.  The current BB.LNG file is for
  1136.       most of ADA.
  1137.  
  1138.          There is a limit of about 250 lines in the BB.LNG file.
  1139.  
  1140.          This part of Blackbeard is somewhat experimental (not in
  1141.       terms of reliability but in terms of probability of change).
  1142.  
  1143.       THE MOUSE
  1144.          A mouse is a productive device for cursor movement and
  1145.       command selection.  The mouse makes interaction with the
  1146.       screen simpler, faster, and more spontaneous.
  1147.  
  1148.          Moving the mouse is as natural as moving your hand.  As you
  1149.       move the mouse, the cursor moves on the screen.
  1150.  
  1151.          The right button on the mouse calls up the menu.  The left
  1152.       button selects items.  The pop-up menu is is placed at the
  1153.       cursor location, your eye's focal point.  The menu is the
  1154.       inverse color of the current window.  The menu item currently
  1155.       selected is the color of the current window.
  1156.  
  1157.          When the cursor is positioned over a menu item, pressing
  1158.       the left button selects a command.
  1159.  
  1160.          The right button on the mouse escapes from the menu without
  1161.       selecting an item.  This button also returns to the main mouse
  1162.       menu from within a sub-menu.
  1163.  
  1164.          Blackbeard now includes an INTEGRAL MOUSE DRIVER for the
  1165.       Microsoft Mouse.  The mouse will be automatically available,
  1166.       if the Mouse driver is loaded.  These buttons correspond to
  1167.       Blackbeard commands.
  1168.  
  1169.       Mouse
  1170.       Button      Key         Typical function
  1171.       Left        Enter or    RETURN & INSERT LINE
  1172.               ^M
  1173.  
  1174.       Right       Esc         MENUS
  1175.  
  1176.          Mouse movements are tranlsated into cursor movements; the
  1177.       left button translates to enter selects menu items; the right
  1178.       button translates to escape pop-ups and exits menus.
  1179.  
  1180.       Mouse Systems
  1181.  
  1182.          The Blackbeard distribution diskette includes a mouse menu
  1183.       driver for the Mouse Systems Mouse.  To use the mouse install
  1184.       the PC mouse menu driver by running MOUSESYS (described in
  1185.       your Mouse Systems Manual).  Run the Blackbeard menu program
  1186.       with the following command:
  1187.  
  1188.         M_BB
  1189.  
  1190.          Mouse movements are tranlsated into cursor movements; the
  1191.       left button translates to enter selects menu items; the right
  1192.       button translates to escape pop-ups and exits menus.
  1193.